package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.EmpAdditionalFieldsAddDTO;
import org.jsola.hr.dto.EmpAdditionalFieldsUpdateDTO;
import org.jsola.hr.query.EmpAdditionalFieldsQuery;
import org.jsola.hr.vo.EmpAdditionalFieldsListVO;
import org.jsola.hr.vo.EmpAdditionalFieldsVO;

import java.util.List;

/**
 * 员工额外字段信息表
 *
 * @author zhr
 */
@Api(tags = "hr-员工额外字段信息表")
public interface IEmpAdditionalFieldsControllerAPI {

    /**
     * 新增员工额外字段信息表
     * @param empAdditionalFieldsAddDTO 员工额外字段信息表新增实体
     * @return 员工额外字段信息表展示对象
     */
    @ApiOperation(value = "新增员工额外字段信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empAdditionalFieldsAddDTO", dataType = "EmpAdditionalFieldsAddDTO", value = "新增员工额外字段信息表", paramType = "body")
    })
    Result<EmpAdditionalFieldsVO> save(EmpAdditionalFieldsAddDTO empAdditionalFieldsAddDTO);


    /**
     * 修改员工额外字段信息表
     * @param empAdditionalFieldsUpdateDTO 员工额外字段信息表
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工额外字段信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empAdditionalFieldsUpdateDTO", dataType = "EmpAdditionalFieldsUpdateDTO", value = "修改员工额外字段信息表", paramType = "body")
    })
    Result<Integer> update(EmpAdditionalFieldsUpdateDTO empAdditionalFieldsUpdateDTO);




    /**
     * 删除单个员工额外字段信息表，彻底删除
     * @param empAdditionalFieldsId 员工额外字段信息表id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工额外字段信息表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empAdditionalFieldsId", dataType = "Long", value = "员工额外字段信息表id", paramType = "path")
    })
    Result<Integer> delete(Long empAdditionalFieldsId);


    /**
     * 批量删除员工额外字段信息表，彻底删除
     * @param empAdditionalFieldsIds 员工额外字段信息表id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工额外字段信息表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empAdditionalFieldsIds", dataType = "Long[]", value = "员工额外字段信息表id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(Long[] empAdditionalFieldsIds);


    /**
     * 根据员工额外字段信息表id查询员工额外字段信息表详情
     * @param empAdditionalFieldsId 员工额外字段信息表id
     * @return 员工额外字段信息表详情
     */
    @ApiOperation(value="根据员工额外字段信息表id查询员工额外字段信息表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empAdditionalFieldsId", dataType = "Long", value = "员工额外字段信息表id", paramType = "path")
    })
    Result<EmpAdditionalFieldsVO> findById(Long empAdditionalFieldsId);


    /**
     * 查询员工额外字段信息表
     * @param empAdditionalFieldsQuery 员工额外字段信息表查询参数
     * @return page
     */
    @ApiOperation(value="查询员工额外字段信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empAdditionalFieldsQuery", dataType = "EmpAdditionalFieldsQuery", value = "员工额外字段信息表查询参数", paramType = "query")
    })
    Result<List<EmpAdditionalFieldsListVO>> listAll(EmpAdditionalFieldsQuery empAdditionalFieldsQuery);


     /**
     * 分页查询员工额外字段信息表
     * @param empAdditionalFieldsQuery 员工额外字段信息表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工额外字段信息表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empAdditionalFieldsQuery", dataType = "EmpAdditionalFieldsQuery", value = "员工额外字段信息表查询参数", paramType = "query")
    })
    Result<Page<EmpAdditionalFieldsListVO>> page(EmpAdditionalFieldsQuery empAdditionalFieldsQuery);


}

